home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / off_09.zip / READER.TXT < prev    next >
Text File  |  1993-01-12  |  5KB  |  153 lines
  1.  -----------------------------------------------------------------------------
  2.   __    ___  ___
  3.  /  \  |__  |__
  4.  \__/  |    |
  5.  
  6.  
  7.  An Informal Documentation Formatter
  8.  
  9.  -----------------------------------------------------------------------------
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                                  READER'S GUIDE
  18.  
  19.                             Vassilis V. Dimakopoulos
  20.  
  21.  
  22.                         --- Last Revision: May 1992 ---
  23.  
  24.  
  25.  
  26.  
  27.                                  Quick overview
  28.  
  29.  
  30.  
  31.           To use OFF make sure that off.exe is in  a  directory  where
  32.           MSDOS can find it (e.g. in one of the  directories  in  your
  33.           PATH variable). If you  want  to  browse  through  the  file
  34.           'fname' then type
  35.  
  36.                                    off fname
  37.  
  38.           When  browsing  through  the  document  you  can  press  the
  39.           following keys:
  40.  
  41.           ■   SPACE or
  42.           ■   ENTER to go to the next page
  43.           ■   Q to quit the program.
  44.  
  45.           OFF can also save  the  document  in  a  file  or  print  it
  46.           directly to a line printer.
  47.  
  48.  
  49.  
  50.  
  51.                                   Plain output
  52.  
  53.  
  54.  
  55.           If you want to convert a document file into a plain  -  with
  56.           no screen attributes - file then type:
  57.  
  58.                             off -a fname > newfname
  59.  
  60.           and the file 'newfname' will contain plain ascii text.  Note
  61.           that the '-a' option is necessary because the normal  output
  62.           of OFF cannot be redirected to a file.
  63.  
  64.  
  65.  
  66.  
  67.                                  Printer output
  68.  
  69.  
  70.  
  71.           OFF can sent a document file  directly  to  a  line  printer
  72.           (which supports the IBM escape  sequences)  using  the  '-p'
  73.           option:
  74.  
  75.                                   off -p fname
  76.  
  77.           NOTES:
  78.  
  79.           1.  The characters that appear with  reversed  background  /
  80.               foreground on the screen, appear as italics on the  line
  81.               printer.
  82.  
  83.           2.  OFF assumes by default that a NLQ  (Near-Letter-Quality)
  84.               printing is  needed.  To  override  this  use  the  '-d'
  85.               option:
  86.  
  87.                                   off -p -d fname
  88.  
  89.               and the printer will use draft quality characters.
  90.  
  91.           3.  While the screen output is  the  default  for  OFF  (and
  92.               consequently the page length is 24 lines), when the '-p'
  93.               or '-a' option is  used,  the  page  length  becomes  by
  94.               default 66 lines. You may need to adjust  this  to  your
  95.               printer page length (or to whatever you want) using  the
  96.               '-l' option. For example
  97.  
  98.                                  off -p -l 54 fname
  99.  
  100.               will set the page length to a usual single-sheet printer
  101.               page.
  102.  
  103.           4.  Similarly the '-p' and '-a' options cause the page width
  104.               to be initialized to 91 columns. Adjust  this  with  the
  105.               '-w' option, e.g.
  106.  
  107.                                  off -p -w 80 fname
  108.  
  109.           Note that the '-d' option is ignored if the '-p'  option  is
  110.           not used and that the '-l' and '-w' options can be used  not
  111.           only for printer but for screen output too.
  112.  
  113.  
  114.  
  115.  
  116.                                    Filenames
  117.  
  118.  
  119.  
  120.           To browse through 'fname' you do  not  need  to  specify  an
  121.           extension.  If  you  give  one  OFF  will   take   it   into
  122.           consideration otherwise it will supply  some  extensions  by
  123.           itself. The extensions OFF gives to 'fname'  (in  the  order
  124.           shown) are
  125.  
  126.           1.  The user extension (if any given)
  127.           2.  .off
  128.           3.  .doc
  129.           4.  .txt
  130.  
  131.           Also you do not have to give the full path on which  'fname'
  132.           resides. OFF will first look for an  environmental  variable
  133.           called  OFFPATH  which  has  the   directories   where   the
  134.           documentation files can normaly  be  found.  Then  OFF  will
  135.           search for 'fname' in  the  following  directories  (in  the
  136.           order shown):
  137.  
  138.           1.  The current directory.
  139.           2.  The directories in your OFFPATH (if it exists).
  140.  
  141.           Note that OFF will search in the following manner:
  142.  
  143.             for each extension
  144.             {
  145.               for each directory
  146.               {
  147.                 if "directory\file.extension" found
  148.                   then Done.
  149.                 else
  150.                   Continue.
  151.               }
  152.             }
  153.